Skip to main content

10.1 Query merchant’s digital currency orders (collection and payment)

#Brief description: This interface is used to query the merchant's digital currency collection, payment and other orders. The order details can be viewed according to the order number.

Query parameters

Parameter nameTypeRequiredParameter meaningParameter description
orderIdstringNoPlatform order numberChoose 1 from our platform order number or merchant’s local order number
localOrderIdstringNoMerchant’s local order numberChoose 1 of 2 merchant’s local order number or our platform’s order number
keystringYesMerchant keyapiKey
signstringYesSignatureSee Signature Algorithm for details
Request json sample
{  
"key": "9yUreYgTRtit39Dy",
"orderId": 274224939517780,
"sign": "07792d2cf97811d3f2e7bd98edb477e3"
}

Return value

Parameter nameTypeParameter meaningParameter description
codeint32Request statusReturn code, 0 means the business is successful, otherwise it represents a different error
successbooleanSuccess statusSuccess identification, consistent with code=0, used for compatibility history
messagestringDescriptionError message. If there is an error, the error message returned
datajsonReturn data.Please refer to the following description for parameters
Return to Example
{
"code": 0,
"success": true,
"message": null,
"data": {
"merchantId": 302992856974,
"merchantUserId": null,
"orderId": "474882554749381",
"localOrderId": "CONAN-TES1225668",
"type": "PAYMENT",
"status": "SUCCESS",
"bizType": "PAYMENT_FIXED_DIGITAL_SCAN",
"currency": "CNY",
"amount": "75",
"merchantCurrency": "CNY",
"merchantPaidAmount": "75",
"merchantActualAmount": "53.85",
"userCurrency": "USDT",
"userAmount": "11.19",
"userReceivableAmount": "11.19",
"userMinerFee": null,
"rate": "6.70227804",
"rateExpression": "1USDT≈6.7022CNY",
"notifyTime": 1772461910628,
"extra": null,
"blockchain": {
"network": "TRON",
"txId":"403dd99b07cb2fd0a4a8ab3f99ef74c0
40700117a3429f393a74585ed3f23c09",
"senderAddress": "TPutFhYUQnrRxHSmKVwjp55vgk9QY6r5nS",
"receiverAddress": "TYZSzcYySHGQ1Kb1oC3GdEM1NiK95BvnX7"
},
"walletUserId": null,
"orderFailReason": null,
"orderCreateTime": 1772461861907
}
}
data parameter description
Parameter nameTypeParameter meaningParameter description
orderIdstringOrder number
merchantIdint64Merchant ID
merchantUserIdstringMerchant user IDReturns the value of the order parameter localUserId, or null if not passed
localOrderIdstringOrder number
statusenumOrder StatusPROCESSING:处理中| SUCCESS:已完成|FAIL:已失败
typeenumOrder TypePAYMENT:支付订单 | WITHDRAW:提款订单
bizTypeenumbizType type description is as follows
currencystringOrder currency
amountstringOrder amount
merchantCurrencystringMerchant payment currency
merchantPaidAmountnumberAmount receivable or payable by the merchant
userCurrencystringUser payment or withdrawal currency
userAmountnumberUser payment or withdrawal amount
merchantActualAmountnumberAmount actually received or paid by the merchant
notifyTimeint64Notification timestamp
orderCreateTimeint64Order creation timestamp
blockchainobjectChain transaction information
└ networkstringmain network
└ txidstringTransaction ID
└senderAddressstringSending address
└receiverAddressstringReceipt address
userMinerFeestringMining fee
userReceivableAmountstringAmounts receivable and payable by users
ratestringExchange rate
rateExpressionstringExchange rate expression
orderFailReasonstringReason for order failure
walletUserIdstringWallet internal user ID
extrajsonCustom exchange rate informationMerchants will return this information when calling the custom exchange rate interface

bizType type description:

  1. PAYMENT_WALLET_SCAN MINPAY wallet scan code payment
  2. PAYMENT_TRANSFER digital currency binding address direct deposit
  3. PAYMENT_ANY_DIGITAL_SCAN Scan the QR code to pay any amount of digital currency
  4. WITHDRAW_WALLET withdraw money to MINPAY wallet
  5. WITHDRAW_ANY_DIGITAL_WALLET Withdraw digital currency to any wallet
  6. PAYMENT_FIXED_DIGITAL_SCAN digital currency limited amount scan code payment
  7. BATCH_PAY batch payment